DELETE
/
tools
/
credentials
/
{credential_id}
Delete Tool Credential
curl --request DELETE \
  --url https://agent-prod.studio.lyzr.ai/v3/tools/credentials/{credential_id} \
  --header 'x-api-key: <api-key>'
{
  "message": "Credential deleted successfully."
}

​
Description

This endpoint deletes a tool credential permanently.

​
Endpoint

DELETE /v3/tools/credentials/{credential_id}

​
Authentication

API Key (x-api-key) must be included in the header.

​
Path Parameters

  • credential_id (string) - The ID of the credential to delete.

​
Response

A message confirming that the credential was deleted.

​
Example Request

curl -X DELETE "https://agent-prod.studio.lyzr.ai/v3/tools/credentials/credential_id" ^
-H "accept: application/json" ^
-H "x-api-key: sk-default-EXAMPLEKEY123"

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
credential_id
string
required

The ID of the credential to delete.

Response

200
application/json

Credential deleted successfully

The response is of type object.